Scripting > CxHmiFms > CxFmsNodeChooserCtrl Object > CxFmsNodeChooserCtrl Methods

CxFmsNodeChooserCtrl Methods

The CxFmsNodeChooserCtrl object contains the following methods:

GetNodeSelection

Returns the list of Nodes currently selected.

Syntax

GetNodeSelection() As Variant

Example

The following example displays a message box showing the list of selected Nodes when a button is pressed.  This example is taken from FMS Node Chooser Ctrl.csf found in the APPS SCREXAMP folder.  

Sub btnGetSelections_EventClick()

Dim This : Set This = btnGetSelections

Dim arySelected

 

arySelected = FmsNodeChooser.GetNodeSelection()

 

Dim i, strMsg

For i = 0 To UBound(arySelected)

strMsg = strMsg & arySelected(i) & Vbcr

Next

 

MsgBox strMsg

End Sub

Back to top

SetNodeSelection

Sets the selection of Nodes.

Syntax

SetNodeSelection(Selections As Variant) As Boolean

Parameters

Parameter

Required

Description

Selections

Yes

The list of Nodes, in "Node ID" format, to select.

Example

The following example selects two Nodes.  This example is taken from FMS Node Chooser Ctrl.csf found in the APPS SCREXAMP folder.

  

Sub btnSetSelections_EventClick()

Dim This : Set This = btnSetSelections

Dim aryNodes

Redim aryNodes(1)

 

aryNodes(0) = "2540"

aryNodes(1) = "2541"

 

FmsNodeChooser.SetNodeSelection aryNodes

End Sub

Back to top

RetrieveNodes

Populates the Node chooser’s list of Nodes.  This method has the same function as the RetrieveNodes button on the Node chooser.

Syntax

RetrieveNodes()

Remarks

When this method is called, the Node chooser is populated according to the SiteServiceSelection, GroupSelection, NodeCategorySelection, FilterString, and FilterType properties.

Example

The following example retrieves Nodes when the View is initialized.

  

Sub TheView_EventInitialize()

Dim This : Set This = TheView

FmsNodeChooser.RetrieveNodes

End Sub

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.